Skip to content

[skip changelog] Make the command documentation of cache clean more clear #1135

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 14, 2021
Merged

[skip changelog] Make the command documentation of cache clean more clear #1135

merged 1 commit into from
Jan 14, 2021

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Jan 13, 2021

The terms "cache" and "clean" might bring compilation to mind, but the arduino-cli cache clean command has nothing to
do with compilation. Many users will likely not even be aware of the existence or purpose of the directories.downloads
folder. For this reason, it's important to make the purpose of this command clear.

Please check if the PR fulfills these requirements

  • The PR has no duplicates (please search among the Pull Requests
    before creating one)
  • The PR follows
    our contributing guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • UPGRADING.md has been updated with a migration guide (for breaking changes)
  • What kind of change does this PR introduce?

docs update

  • What is the current behavior?

The terms "cache" and "clean" might bring compilation to mind, but the arduino-cli cache clean command has nothing to
do with compilation. Many users will likely not even be aware of the existence or purpose of the directories.downloads
folder. It's not very clear from the command documentation for arduino-cli cache clean what it does.

For example:
#969 (comment)

At first glance arduino-cli cache clean might do this, but the --help output does not specify what it cleans exactly, cache clean -v does not show what is removed either, and a quick test suggests that it does not clean the build directory.

  • What is the new behavior?

The purpose of the arduino-cli cache clean is more clearly described in the command line documentation.

No

  • Other information:

See how to contribute

…lear

The terms "cache" and "clean" might bring compilation to mind, but the `arduino-cli cache clean` command has nothing to
do with compilation. Many users will likely not even be aware of the existence or purpose of the `directories.downloads`
folder. For this reason, it's important to make the purpose of this command clear.
@per1234 per1234 merged commit c30031b into arduino:master Jan 14, 2021
@per1234 per1234 deleted the clarify-cache-clean-docs branch January 14, 2021 14:33
@per1234 per1234 self-assigned this Nov 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants